home *** CD-ROM | disk | FTP | other *** search
- /*
- * DO NOT EDIT. THIS FILE IS GENERATED FROM nsIAccessibleRetrieval.idl
- */
-
- #ifndef __gen_nsIAccessibleRetrieval_h__
- #define __gen_nsIAccessibleRetrieval_h__
-
-
- #ifndef __gen_nsISupports_h__
- #include "nsISupports.h"
- #endif
-
- /* For IDL files that don't want to include root IDL files. */
- #ifndef NS_NO_VTABLE
- #define NS_NO_VTABLE
- #endif
- class nsIDOMNode; /* forward declaration */
-
- class nsIAccessible; /* forward declaration */
-
- class nsIWeakReference; /* forward declaration */
-
- class nsIPresShell; /* forward declaration */
-
- class nsIDOMWindow; /* forward declaration */
-
- class nsIAccessNode; /* forward declaration */
-
-
- /* starting interface: nsIAccessibleRetrieval */
- #define NS_IACCESSIBLERETRIEVAL_IID_STR "663ca4a8-d219-4000-925d-d8f66406b626"
-
- #define NS_IACCESSIBLERETRIEVAL_IID \
- {0x663ca4a8, 0xd219, 0x4000, \
- { 0x92, 0x5d, 0xd8, 0xf6, 0x64, 0x06, 0xb6, 0x26 }}
-
- /**
- * An interface for in-process accessibility clients
- * wishing to get an nsIAccessible or nsIAccessNode for
- * a given DOM node.
- * More documentation at:
- * http://www.mozilla.org/projects/ui/accessibility
- *
- * @status UNDER_REVIEW
- */
- class NS_NO_VTABLE nsIAccessibleRetrieval : public nsISupports {
- public:
-
- NS_DEFINE_STATIC_IID_ACCESSOR(NS_IACCESSIBLERETRIEVAL_IID)
-
- /**
- * Return an nsIAccessible for a DOM node in pres shell 0.
- * Create a new accessible of the appropriate type if necessary,
- * or use one from the accessibility cache if it already exists.
- * @param aNode The DOM node to get an accessible for.
- * @return The nsIAccessible for the given DOM node.
- */
- /* nsIAccessible getAccessibleFor (in nsIDOMNode aNode); */
- NS_IMETHOD GetAccessibleFor(nsIDOMNode *aNode, nsIAccessible **_retval) = 0;
-
- /**
- * Return an nsIAccessible for a DOM node in pres shell for this DOM window.
- * Create a new accessible of the appropriate type if necessary,
- * or use one from the accessibility cache if it already exists.
- * @param aNode The DOM node to get an accessible for.
- * @param aDOMWin The DOM window containing the node.
- * @return The nsIAccessible for the given DOM node.
- */
- /* nsIAccessible getAccessibleInWindow (in nsIDOMNode aNode, in nsIDOMWindow aDOMWin); */
- NS_IMETHOD GetAccessibleInWindow(nsIDOMNode *aNode, nsIDOMWindow *aDOMWin, nsIAccessible **_retval) = 0;
-
- /**
- * Return an nsIAccessible for a DOM node in the given weak shell.
- * Create a new accessible of the appropriate type if necessary,
- * or use one from the accessibility cache if it already exists.
- * @param aNode The DOM node to get an accessible for.
- * @param aPresShell The presentation shell which contains layout info for the DOM node.
- * @return The nsIAccessible for the given DOM node.
- */
- /* nsIAccessible getAccessibleInWeakShell (in nsIDOMNode aNode, in nsIWeakReference aPresShell); */
- NS_IMETHOD GetAccessibleInWeakShell(nsIDOMNode *aNode, nsIWeakReference *aPresShell, nsIAccessible **_retval) = 0;
-
- /**
- * Return an nsIAccessible for a DOM node in the given pres shell.
- * Create a new accessible of the appropriate type if necessary,
- * or use one from the accessibility cache if it already exists.
- * @param aNode The DOM node to get an accessible for.
- * @param aPresShell The presentation shell which contains layout info for the DOM node.
- * @return The nsIAccessible for the given DOM node.
- */
- /* nsIAccessible getAccessibleInShell (in nsIDOMNode aNode, in nsIPresShell aPresShell); */
- NS_IMETHOD GetAccessibleInShell(nsIDOMNode *aNode, nsIPresShell *aPresShell, nsIAccessible **_retval) = 0;
-
- /**
- * Return an nsIAccessNode for an already created DOM node in the given weak shell.
- * Does not create a new one -- only returns cached access nodes.
- * @param aNode The DOM node to get an access node for.
- * @param aPresShell The presentation shell which contains layout info for the DOM node.
- * @return The nsIAccessNode for the given DOM node or null if
- * an access node does not already exist for this DOM node.
- */
- /* nsIAccessNode getCachedAccessNode (in nsIDOMNode aNode, in nsIWeakReference aShell); */
- NS_IMETHOD GetCachedAccessNode(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessNode **_retval) = 0;
-
- /**
- * Return an nsIAccessible for an already created DOM node in the given weak shell.
- * Does not create a new one -- only returns cached accessibles.
- * @param aNode The DOM node to get an accessible for.
- * @param aPresShell The presentation shell which contains layout info for the DOM node.
- * @return The nsIAccessible for the given DOM node or null if
- * an accessible does not already exist for this DOM node.
- */
- /* nsIAccessible getCachedAccessible (in nsIDOMNode aNode, in nsIWeakReference aShell); */
- NS_IMETHOD GetCachedAccessible(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessible **_retval) = 0;
-
- };
-
- /* Use this macro when declaring classes that implement this interface. */
- #define NS_DECL_NSIACCESSIBLERETRIEVAL \
- NS_IMETHOD GetAccessibleFor(nsIDOMNode *aNode, nsIAccessible **_retval); \
- NS_IMETHOD GetAccessibleInWindow(nsIDOMNode *aNode, nsIDOMWindow *aDOMWin, nsIAccessible **_retval); \
- NS_IMETHOD GetAccessibleInWeakShell(nsIDOMNode *aNode, nsIWeakReference *aPresShell, nsIAccessible **_retval); \
- NS_IMETHOD GetAccessibleInShell(nsIDOMNode *aNode, nsIPresShell *aPresShell, nsIAccessible **_retval); \
- NS_IMETHOD GetCachedAccessNode(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessNode **_retval); \
- NS_IMETHOD GetCachedAccessible(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessible **_retval);
-
- /* Use this macro to declare functions that forward the behavior of this interface to another object. */
- #define NS_FORWARD_NSIACCESSIBLERETRIEVAL(_to) \
- NS_IMETHOD GetAccessibleFor(nsIDOMNode *aNode, nsIAccessible **_retval) { return _to GetAccessibleFor(aNode, _retval); } \
- NS_IMETHOD GetAccessibleInWindow(nsIDOMNode *aNode, nsIDOMWindow *aDOMWin, nsIAccessible **_retval) { return _to GetAccessibleInWindow(aNode, aDOMWin, _retval); } \
- NS_IMETHOD GetAccessibleInWeakShell(nsIDOMNode *aNode, nsIWeakReference *aPresShell, nsIAccessible **_retval) { return _to GetAccessibleInWeakShell(aNode, aPresShell, _retval); } \
- NS_IMETHOD GetAccessibleInShell(nsIDOMNode *aNode, nsIPresShell *aPresShell, nsIAccessible **_retval) { return _to GetAccessibleInShell(aNode, aPresShell, _retval); } \
- NS_IMETHOD GetCachedAccessNode(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessNode **_retval) { return _to GetCachedAccessNode(aNode, aShell, _retval); } \
- NS_IMETHOD GetCachedAccessible(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessible **_retval) { return _to GetCachedAccessible(aNode, aShell, _retval); }
-
- /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
- #define NS_FORWARD_SAFE_NSIACCESSIBLERETRIEVAL(_to) \
- NS_IMETHOD GetAccessibleFor(nsIDOMNode *aNode, nsIAccessible **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAccessibleFor(aNode, _retval); } \
- NS_IMETHOD GetAccessibleInWindow(nsIDOMNode *aNode, nsIDOMWindow *aDOMWin, nsIAccessible **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAccessibleInWindow(aNode, aDOMWin, _retval); } \
- NS_IMETHOD GetAccessibleInWeakShell(nsIDOMNode *aNode, nsIWeakReference *aPresShell, nsIAccessible **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAccessibleInWeakShell(aNode, aPresShell, _retval); } \
- NS_IMETHOD GetAccessibleInShell(nsIDOMNode *aNode, nsIPresShell *aPresShell, nsIAccessible **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAccessibleInShell(aNode, aPresShell, _retval); } \
- NS_IMETHOD GetCachedAccessNode(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessNode **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCachedAccessNode(aNode, aShell, _retval); } \
- NS_IMETHOD GetCachedAccessible(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessible **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCachedAccessible(aNode, aShell, _retval); }
-
- #if 0
- /* Use the code below as a template for the implementation class for this interface. */
-
- /* Header file */
- class nsAccessibleRetrieval : public nsIAccessibleRetrieval
- {
- public:
- NS_DECL_ISUPPORTS
- NS_DECL_NSIACCESSIBLERETRIEVAL
-
- nsAccessibleRetrieval();
-
- private:
- ~nsAccessibleRetrieval();
-
- protected:
- /* additional members */
- };
-
- /* Implementation file */
- NS_IMPL_ISUPPORTS1(nsAccessibleRetrieval, nsIAccessibleRetrieval)
-
- nsAccessibleRetrieval::nsAccessibleRetrieval()
- {
- /* member initializers and constructor code */
- }
-
- nsAccessibleRetrieval::~nsAccessibleRetrieval()
- {
- /* destructor code */
- }
-
- /* nsIAccessible getAccessibleFor (in nsIDOMNode aNode); */
- NS_IMETHODIMP nsAccessibleRetrieval::GetAccessibleFor(nsIDOMNode *aNode, nsIAccessible **_retval)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* nsIAccessible getAccessibleInWindow (in nsIDOMNode aNode, in nsIDOMWindow aDOMWin); */
- NS_IMETHODIMP nsAccessibleRetrieval::GetAccessibleInWindow(nsIDOMNode *aNode, nsIDOMWindow *aDOMWin, nsIAccessible **_retval)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* nsIAccessible getAccessibleInWeakShell (in nsIDOMNode aNode, in nsIWeakReference aPresShell); */
- NS_IMETHODIMP nsAccessibleRetrieval::GetAccessibleInWeakShell(nsIDOMNode *aNode, nsIWeakReference *aPresShell, nsIAccessible **_retval)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* nsIAccessible getAccessibleInShell (in nsIDOMNode aNode, in nsIPresShell aPresShell); */
- NS_IMETHODIMP nsAccessibleRetrieval::GetAccessibleInShell(nsIDOMNode *aNode, nsIPresShell *aPresShell, nsIAccessible **_retval)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* nsIAccessNode getCachedAccessNode (in nsIDOMNode aNode, in nsIWeakReference aShell); */
- NS_IMETHODIMP nsAccessibleRetrieval::GetCachedAccessNode(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessNode **_retval)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* nsIAccessible getCachedAccessible (in nsIDOMNode aNode, in nsIWeakReference aShell); */
- NS_IMETHODIMP nsAccessibleRetrieval::GetCachedAccessible(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessible **_retval)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* End of implementation class template. */
- #endif
-
- // for component registration
- // {663CA4A8-D219-4000-925D-D8F66406B626}
- #define NS_ACCESSIBLE_RETRIEVAL_CID \
- { 0x663ca4a8, 0xd219, 0x4000, { 0x92, 0x5d, 0xd8, 0xf6, 0x64, 0x6, 0xb6, 0x26 } }
-
- #endif /* __gen_nsIAccessibleRetrieval_h__ */
-